ISCModelObjectCollection::Collect Arguments

Here is the signature for the Collect function:

ISCModelObjectCollection * Collect(VARIANT Root, VARIANT ClassId, VARIANT Depth, VARIANT MustBeOn, VARIANT MustBeOff)

The following table contains the valid arguments for the Collect function:

Parameter	Valid Type/Value	Description
Root	VT_UNKNOWN � ISCModelObject pointer of the root object	Provides a context (parent) object for the collection.
Root	VT_BSTR � ID of the root object	Provides a context (parent) object for the collection.
ClassId [optional]	VT_ARRAY\|VT_BSTR � SAFEARRAY of class IDs	Contains a list of acceptable class identifiers.
ClassId [optional]	VT_ARRAY\|VT_BSTR � SAFEARRAY of class names	Contains a list of acceptable class names.
ClassId [optional]	VT_BSTR � Class ID	Provides a class identifier for a monotype collection.
ClassId [optional]	VT_BSTR � Semicolon delimited list of class IDs	Contains a list of acceptable class identifiers.
ClassId [optional]	VT_BSTR � Class name	Provides a type name for a monotype collection.
ClassId [optional]	VT_BSTR � Semicolon delimited list of class names	Contains a list of acceptable class names.
ClassId [optional]	Empty	Returns all descendents regardless of class type.
Depth [optional]	VT_I4 � Maximum depth for descendents. Depth of 1 returns the immediate children of the root. A depth of -1 (which is the default value) represents unlimited depth.	Returns the descendents of the root at a depth no more than the given depth.
Depth [optional]	Empty	Returns all descendents of the root (unlimited depth).
MustBeOn [optional]	VT_I4 � SC_ModelObjectFlags that must be set	Provides a set of required flags.
MustBeOn [optional]	Empty	Defaults to SCD_MOF_DONT_CARE.
MustBeOff [optional]	VT_I4 � SC_ModelObjectFlags that must not be set	Provides a set of flags that must not be set.
MustBeOff [optional]	Empty	Defaults to SCD_MOF_DONT_CARE.

For information about valid object class names and identifiers, see the HTML document erwin Metamodel Reference, in the Metamodel Reference Bookshelf located in the erwin Data Modeler installation folder. More information about SC_ModelObjectFlags is located in the Enumerations section.